home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-13 / ne_edit.zip / NE.DOC < prev    next >
Text File  |  1992-07-16  |  21KB  |  485 lines
  1.  
  2.  
  3.                                    NE.EXE
  4.                                July 13, 1992
  5.  
  6.  
  7. INTRODUCTION
  8. ------------
  9.  
  10. This small, fast editor is based  on  the IDE   editor from BORLAND.  It has
  11. MANY features including wordwarp and spell checking.
  12.  
  13. This limited documentation  is provided to  help you get started. Please use
  14. the help feature of the program  (F1)  and read  about the various features.
  15. Many of the commands are  WORDSTAR, and if you are  familiar  with this very
  16. popular editor, you'll catch on fast.
  17.  
  18. The rest of this document deals with the  some of the features of the editor
  19. editor, and may  help  you to work   through  any problems that you have.  I
  20. think once you'll find this editor to be one of the better ones around.
  21.  
  22. SPELL CHECKING
  23. --------------
  24.  
  25. This editor provides  for what  has   got to  be one  of  the most important
  26. functions of any word   processor,  at   least for   me,  and  that is spell
  27. checking. Without it, I'm afraid that  I'd be lost. The spell check  program
  28. that I use is  Webster's New World spelling  checker,  but   there are  many
  29. "shareware" checkers around  that  work  just as  well.  One popular one  is
  30. "SHARESPELL" by Acropolis, found on many BBS's around the country.
  31.  
  32. To access the spell checking,  you MUST tell the program  what spell checker
  33. you will use.  To do  this, from the DOS command  line type "NE SPELL=????",
  34. (replace the question marks with  the  name of the program  you  want to use
  35. for spell  checking.).  The program will  remember this until you change it.
  36. One IMPORTANT NOTE : Make sure that the spell check  program is SOMEWHERE in
  37. your path statement.  To check your path, type "PATH" at the  DOS prompt and
  38. all of the current paths will be displayed.  If the spell checker  IS NOT in
  39. one of these paths, then place it  there or at its path the the current PATH
  40. statement. If you don't the  editor will  not  find it,  and spell  checking
  41. will be disabled.
  42.  
  43. After all this is done,   Spell checking can be accessed from  the editor by
  44. pressing the keys "ALT E" (Edit Menu) and then pressing the "S" key.
  45.  
  46.  
  47. PRINTING THE DOCUMENT
  48. ---------------------
  49.  
  50. Choose PRINT from  the menu  (ALT P) and you  are given the option  to print
  51. the current document, set the top print margin,  the left print margin or to
  52. select the type of printer that  you   are using. The  printer  choices  are
  53. common ones, and hopefully you will be able   to  find one  that  suits your
  54. printer. Text will be printed in  NEAR  LETTER QUALITY  mode, and the choice
  55. tells the program what control codes to send to your printer.
  56.  
  57. The margin settings   and printer choice are saved   for  future use  of the
  58. program, and will be in effect until the next time you change them.
  59.  
  60. The WORDSTAR command ^KP   is  available for  document   printing, and   the
  61. document will be printed with the current settings.
  62.  
  63. As printing occurs, the line and cursor indicator will be updated.  Pressing
  64. ESCAPE will cease the printing operation at any time.
  65.  
  66.  
  67. 43/50 LINE VIDEO
  68. ----------------
  69.  
  70. You will have  the capability of using 43/50 line screens if you have EGA or
  71. better.  The option  can  be found in the DESKTOP menu.  It is automatically
  72. disabled if the user doesn't have the capability.
  73.  
  74. Note that Load/Store   remembers  what video  mode   you  were in and resets
  75. the program to that mode when the desktop is automatically loaded.
  76.  
  77.  
  78.  
  79. AUTOINDENT
  80. ----------
  81.  
  82. The AutoIndent command is ^QI.  This makes the editor conform to WordStar.
  83.  
  84.  
  85. CENTERING TEXT
  86. --------------
  87.  
  88. A line of text may be centered  by   using ^OC.   Centering is based on  the
  89. setting of the Right_Margin.  If  a line is blank, or the length of the line
  90. exceeds the Right_Margin value,   nothing     will  happen.    Spaces at the
  91. beginning of lines are not used when calculating the line length.
  92.  
  93. The cursor will be moved to the end of the line after it has been centered.
  94.  
  95. COLORS
  96. ------
  97.  
  98. To be quite honest, the whole business of allowing users to change colors is
  99. quite a problem.  It adds a lot  of code to the program, and more often than
  100. not, it is used only once  by  the  user.  I like  the  colors   that I have
  101. chosen, If you don't, find another editor.
  102.  
  103. CTRL-BACKSPACE
  104. --------------
  105.  
  106. This feature will allow two options for deleting text from the cursor to the
  107. left margin.  You can use ^BackSpace or ^QH.
  108.  
  109.  
  110. CTRL-HOME AND CTRL-END
  111. ----------------------
  112.  
  113. You have the ability to jump to the top and bottom of a page.  [Ctrl]-[Home]
  114. will take the cursor to the  top of a page and [Ctrl]-[End] will  take   the
  115. cursor to the bottom of a page.
  116.  
  117. Note that the  cursor does NOT go to the first  position in  the   line. The
  118. actual position it ends up at is based on the current position of the cursor
  119. on the current line when  one  of  these key sequences are pressed, and  the
  120. length of the new line it ends up on.
  121.  
  122. PARAGRAPH REFORMAT
  123. ------------------
  124.  
  125. This feature is available to  the  user via the ^B key.  It works regardless
  126. of whether or not wordwrap is active.  Reformatting is based on  the current
  127. right margin position.  As with wordwrap,  reformatting   is not possible if
  128. the cursor is beyond the right margin position.  An error dialog will appear.
  129.  
  130. Paragraph reformat also works with the AutoIndent  feature.  However, it  is
  131. important to note that the reformat  process is    based on the current line
  132. the cursor happens to  be sitting  on when ^B is pressed.  Therefore, if you
  133. use hanging paragraphs  (a paragraph where the first line sticks out further
  134. to the left margin than  the rest of the paragraph) you need  to be careful.
  135. If the cursor  is on the first line of the paragraph, the reformatting takes
  136. place according to that line's left margin  setting.  This is a feature, not
  137. a bug.  Try the same thing with MicroStar or SideKick  and you'll see what I
  138. mean.
  139.  
  140. If AutoIndent is on,  and the paragraph   is so indented   that reformatting
  141. encounters a word that will not fit on  the  line according  to the left and
  142. right margin settings, an    error   dialog   will appear.     However,  any
  143. reformatting accomplished prior to this situation will  have   taken effect.
  144. The cursor should stop on the  word it couldn't wrap.  This should  preclude
  145. the reformatting process locking up the system  because it can't wrap a word
  146. that is too long.
  147.  
  148. The cursor will end up at the first blank line after the  paragraph when you
  149. press ^B.  Therefore, you can reformat paragraphs in quick succession.
  150.  
  151. Note that unlike  some other editors,  this   implementation    of paragraph
  152. reformatting will retain  double spaces after  periods, exclamation  points,
  153. question marks, and colons.  If    you  are in  the habit of  only using one
  154. space, it's not syntactically correct.  Two spaces will be inserted instead,
  155. providing the cursor was sitting on one of  these punctuation marks when the
  156. reformatting process was doing its thing.  Otherwise, no change will be made
  157. to your original text.
  158.  
  159.  
  160. DOCUMENT REFORMAT
  161. -----------------
  162.  
  163. Pressing ^QU will allow  you to reformat a document from either  the current
  164. line, or the beginning of a document, to the  end of the document.  A dialog
  165. box appears with radio  buttons asking  you     where  you want     to start
  166. reformatting.
  167.  
  168. You must be VERY careful   when    using  this  option.  It is based on  the
  169. paragraph reformat feature.  You will note in that section that reformatting
  170. is based on the indentation of the first line in a paragraph, and whether or
  171. not the AutoIndent feature is toggled on.
  172.  
  173. Your screen will scroll to follow the reformat process. This allows the user
  174. to know something is  happening, instead of just having  the  system lock up
  175. while text is reformatted.
  176.  
  177.  
  178. PARAGRAPH JUSTIFY
  179. -----------------
  180.  
  181. Pressing ^OJ will allow you to RIGHT   JUSTIFY the  current  paragraph.  The
  182. entire paragraph EXCLUDING  the last line will  be  lined up  with the right
  183. margin setting.
  184.  
  185.  
  186. END OF LINE SPACES
  187. ------------------
  188.  
  189. Spaces at the end of lines are automatically removed.  This was  required to
  190. make the wordwrap and reformat feature work properly.  Spaces on blank lines
  191. are also removed.  Only the CR/LF is kept.
  192.  
  193. Spaces are NOT  removed until the cursor has traveled  over or onto  a line.
  194. Therefore, if you load  a file created by another ASCII editor that does not
  195. strip spaces, they will remain  in the   document until you move through the
  196. document with the cursor keys.
  197.  
  198.  
  199.  
  200. INDICATOR LINE
  201. --------------
  202.  
  203. The Edit Indicator  line  appears at the bottom of the  edit window.  If the
  204. text has been modified,    an    "M" appears.   Also,   an "I"  appears when
  205. AutoIndent is active, and a "W" pops up when wordwrap is on.   Additionally,
  206. the current line and column is indicated (line:col);
  207.  
  208. INSERT NEW LINE
  209. ---------------
  210.  
  211. Pressing ^N will insert a  CR/LF pair at  the current cursor  position.  All
  212. characters AT the cursor and to the  end of the  line will be moved  down to
  213. the next line.  The difference between pressing  ^N and [Enter] is that with
  214. ^N the cursor  stays at  its current position and does NOT  move down to the
  215. next line.  The only exception to this would be if the cursor was at the end
  216. of a line that has its spaces removed when ^N is pressed.  In that case, the
  217. cursor goes to the new end of line.
  218.  
  219. JUMP TO LINE NUMBER
  220. -------------------
  221.  
  222. Pressing ^JL will allow the user  to  jump to a particular  line  number.  A
  223. dialog box will   appear that requests the user input a line number to  jump
  224. to.  Valid entries range from 1 to 9999.
  225.  
  226.  
  227. LOAD/STORE OPERATIONS
  228. ---------------------
  229.  
  230. The editor keeps track of the LAST files that were edited, and saves  a file
  231. to disk ending in ".DSK".  The next time into the editor, the previous files
  232. will be loaded.   However, if you start the editor  with a NEW command line,
  233. this file WILL NOT BE LOADED.  This editor is a MULTIPLE file editor, and up
  234. to 16 files can  be   loaded  at   once.  See the SYNTAX section    for more
  235. information.
  236.  
  237. MEMORY
  238. ------
  239.  
  240. Only files of  64K  or  less can be edited with this  editor.  Maybe one  of
  241. these  days, I'll get  around to  creating  a "VIRTUAL" editor, but this one
  242. ain't it.
  243.  
  244.  
  245. PLACE MARKERS
  246. -------------
  247.  
  248. This editor allows the user to set place markers  within the document.  ^K#,
  249. where # is a value between 1  and 0 on the keyboard, allows the user  to set
  250. up to 10 place  markers.   The user can  jump to  a place marker by pressing
  251. ^Q#, where # is a value between 1 and 0 on the keyboard.
  252.  
  253. Place markers are not visible, but they are there none-the-less.
  254.  
  255. Place markers are constantly  updated as the user inserts and deletes  text.
  256. If a place  marker is contained within text that is deleted,  it is set back
  257. to zero.  The cursor key goes  nowhere if it encounters a place  marker with
  258. a zero value as a  result of a  ^Q# request.  Of course, this also means you
  259. can not set   a  place   marker in column 1   of line  1, for it is the  0th
  260. position in the document.  Use [Ctrl]-[PgUp] instead!
  261.  
  262.  
  263. PRESET TABS
  264. -----------
  265.  
  266. The preset tab feature allows the user to define up  to 74 tab  stops.   The
  267. ^OI keys will bring up a tab stop dialog box.   The  box has a  ruler across
  268. the top and an input line beneath the ruler.
  269.  
  270. To set tabs, the user   should place a  character in the input line directly
  271. beneath the ruler   setting where  a tab is wanted.  Note  that if the input
  272. line is filled with spaces the user will not be able to enter any data.
  273.  
  274. Tab Settings is automatically initialized to increments of 7.
  275.  
  276. Pressing [Esc] or the OK dialog button will keep the current Tab Settings.
  277.  
  278. RIGHT MARGIN
  279. ------------
  280.  
  281. The user can set the right margin of the document.  This is done by pressing
  282. the ^OR sequence.  A dialog box will appear asking the user to enter a right
  283. margin value.  The  current value will be  shown each  time the dialog comes
  284. up.  The default value is 76.  The  user has only  three options; enter  the
  285. value, press the OK button, or press [Esc].  Pressing  OK or [Esc] will keep
  286. the current value.  Valid entries are 10 through 255.  If the user enters  a
  287. value that is not   within this  range, the current value is maintained.  No
  288. error message will be given!
  289.  
  290.  
  291. SAVE FEATURES
  292. -------------
  293.  
  294. The most important WordStar commands that apply to saving the document have
  295. been implemented.
  296.  
  297.  
  298.   [F2] or ^KS -     Save text to current file and
  299.                     resume editing.
  300.   ^KF         -     Save text to another file.
  301.   ^KD or ^KX  -     Save text to current file and exit
  302.                     editor.
  303.  
  304.  
  305. SCROLL DOWN
  306. -----------
  307.  
  308. Pressing ^Z provides  the    function   of  scrolling  the  screen up  while
  309. maintaining the cursor position.  If  the original cursor  position  scrolls
  310. off the screen,  the cursor scrolls  down a line.  This forces the cursor to
  311. stay in the  upper   left corner  of  the screen should the original  cursor
  312. position scroll away.
  313.  
  314.  
  315. SCROLL UP
  316. ---------
  317.  
  318. Pressing ^W provides the   function    of scrolling   the screen  down while
  319. maintaining the cursor position.   If   the original cursor position scrolls
  320. off the screen, the  cursor  scrolls up  a line.   This forces the cursor to
  321. stay in the lower left corner  of the screen  should   the original   cursor
  322. position scroll away.
  323.  
  324.  
  325.  
  326. SELECT WORD
  327. -----------
  328.  
  329. Pressing ^KT will highlight the current word the cursor is sitting on.
  330.  
  331. The word is marked from the current cursor  position to the  next  space  or
  332. end of line,  whichever comes  first.  The marked  word   is  put into   the
  333. clipboard without further effort  on the  users  part.  Marking works in the
  334. normal manner, i.e., it disappears the moment you move the cursor.
  335.  
  336. Note that NOTHING  will happen if  you try to    use this  command  when the
  337. cursor is sitting on a space or the end of a line.
  338.  
  339.  
  340. TABS
  341. ----
  342.  
  343. When in INSERT mode, the  cursor  will attempt to go to  the next tab  stop,
  344. happily INSERTING SPACES as it looks for that next stopping point.  If it is
  345. at the last tab stop, it stops inserting spaces and takes a big jump  to the
  346. first character of the next line.  Try to keep tab use to a minimum when the
  347. cursor is in insert mode.  You eat up valuable buffer space real quick!
  348.  
  349. When in OVERSTRIKE mode, the cursor will attempt to go to the next tab stop,
  350. happily skipping over characters as  it  looks for that next stopping point.
  351. If it is at the last tab stop, OR the line is too short to allow it to reach
  352. the next tab stop,  it takes a big jump to the first character  of the  next
  353. line.
  354.  
  355. UNDO
  356. ----
  357.  
  358. ^U is the normal   UNDO sequence.  However  you can get the  same thing with
  359. ^QL.  The line is restored to its condition BEFORE any carriage return.
  360.  
  361.  
  362. WORDWRAP
  363. --------
  364.  
  365. Wordwrap is toggled on/off via the ^OW sequence.  When wordwrap is on, a "W"
  366. appears on the  status line.  Wordwrap is fast, and should keep  up with the
  367. most fluid typist.  There should be no "jerkiness" in the wrap effect.
  368.  
  369. Wordwrap is based on the "push the  line  out  to the right until the cursor
  370. reaches the current right margin setting"  principle.  Therefore, if you are
  371. on a line and inserting  text,    the text will be  pushed  beyond the right
  372. margin until the cursor  gets there,  at   which point the text beyond   the
  373. cursor is wrapped.
  374.  
  375. The right margin is considered to be the  current  right margin value +   1.
  376. For example, if your right margin is set to 69, then the  cursor CAN   go to
  377. column 70.  Trying to exceed column 70 will cause wordwrap to occur.
  378.  
  379. Wordwrap will not work if the  cursor is   beyond the current  right  margin
  380. setting.  In this event, an error dialog box will appear.
  381.  
  382. Wordwrap will also work with the AutoIndent mode  turned on.   In this case,
  383. the cursor goes to the same first character position on the new line as  the
  384. line it was on when wrap occurred.
  385.  
  386. If you try to type a blank line of spaces to the right margin, wordwrap will
  387. remove the spaces and insert just a CR/LF pair.  Wordwrap will also bring up
  388. an error message if you try to   type in  an  entire line out to  the  right
  389. margin without spaces.
  390.  
  391.  
  392. COMMAND SUMMARY
  393. ---------------
  394.  
  395. The following list contains all the commands available in the editor :
  396.  
  397. Command                  Description
  398. --------------------     ------------------------------------------------
  399.  
  400.           [Ctrl]-[A] -   Move cursor left to previous word.
  401.           [Ctrl]-[B] -   Reformat paragraph to current margins.
  402.           [Ctrl]-[C] -   Page down one screen.
  403.           [Ctrl]-[D] -   Move cursor right one character.
  404.           [Ctrl]-[E] -   Move cursor up one line.
  405.           [Ctrl]-[F] -   Move cursor right to next word.
  406.           [Ctrl]-[G] -   Delete character cursor is on.
  407.           [Ctrl]-[H] -   Delete character to left of cursor.
  408.           [Ctrl]-[I] -   Move right to next tab position.
  409.       [Ctrl]-[J]-[L] -   Jump to a line number.
  410.       [Ctrl]-[K]-[#] -   Set place marker (0 to 9).
  411.       [Ctrl]-[K]-[B] -   Begin selecting text.
  412.       [Ctrl]-[K]-[C] -   Copy text from clipboard into document.
  413.       [Ctrl]-[K]-[D] -   Save document and exit editor immediately.
  414.       [Ctrl]-[K]-[F] -   Save current document to another file.
  415.       [Ctrl]-[K]-[K] -   Copy text from document into clipboard.
  416.       [Ctrl]-[K]-[P] -   Print current document using current settings.
  417.       [Ctrl]-[K]-[S] -   Save document and continue editing.
  418.       [Ctrl]-[K]-[T] -   Select current word cursor is on.
  419.       [Ctrl]-[K]-[Y] -   Remove text from document into clipboard.
  420.       [Ctrl]-[K]-[X] -   Save document and exit editor immediately.
  421.           [Ctrl]-[L] -   Continue searching for specified text.
  422.           [Ctrl]-[M] -   Enter CR/LF pair.
  423.           [Ctrl]-[N] -   Add CR/LF pair AT cursor and keep cursor position.
  424.       [Ctrl]-[O]-[D] -   Output current DATE into text.
  425.       [Ctrl]-[O]-[I] -   Set tab positions.
  426.       [Ctrl]-[O]-[J] -   Right Justify Paragraph.
  427.       [Ctrl]-[O]-[R] -   Set right margin position of line.
  428.       [Ctrl]-[O]-[T] -   Output current TIME into text.
  429.       [Ctrl]-[O]-[W] -   Toggle word wrap mode on or off.
  430.       [Ctrl]-[Q]-[#] -   Move cursor to specified place marker (0 to 9).
  431.       [Ctrl]-[Q]-[A] -   Search for text and replace it.
  432.       [Ctrl]-[Q]-[C] -   Move cursor to end of document.
  433.       [Ctrl]-[Q]-[D] -   Move cursor to end of line.
  434.       [Ctrl]-[Q]-[F] -   Find specified text.
  435.       [Ctrl]-[Q]-[H] -   Delete text from cursor to start of line.
  436.       [Ctrl]-[Q]-[I] -   Toggle IndentMode on and off.
  437.       [Ctrl]-[Q]-[R] -   Move cursor to beginning of document.
  438.       [Ctrl]-[Q]-[S] -   Move cursor to beginning of line
  439.       [Ctrl]-[Q]-[U] -   Reformat the document text.
  440.       [Ctrl]-[Q]-[Y] -   Delete text from cursor to end of line.
  441.           [Ctrl]-[R] -   Page up one screen.
  442.           [Ctrl]-[S] -   Move cursor left one character.
  443.           [Ctrl]-[T] -   Delete text from current cursor to next word.
  444.           [Ctrl]-[U] -   Restore text to previous state.
  445.           [Ctrl]-[V] -   Toggle cursor between insert and overstrike mode.
  446.           [Ctrl]-[W] -   Scroll screen up one line keeping cursor position.
  447.           [Ctrl]-[X] -   Move cursor down one line.
  448.           [Ctrl]-[Y] -   Delete line of text cursor is on.
  449.           [Ctrl]-[Z] -   Scroll screen down one line keeping cursor position.
  450.          [Backspace] -   Delete character to left of cursor.
  451.         [Left Arrow] -   Move cursor left one character.
  452.        [Right Arrow] -   Move cursor right one character.
  453.  [Ctrl]-[Left Arrow] -   Move cursor left to previous word.
  454. [Ctrl]-[Right Arrow] -   Move cursor right to next word.
  455.               [Home] -   Move cursor to start of line.
  456.                [End] -   Move cursor to end of line.
  457.        [Ctrl]-[Home] -   Move cursor to top of current page.
  458.         [Ctrl]-[End] -   Move cursor to bottom of current page.
  459.           [Up Arrow] -   Move cursor up one line.
  460.         [Down Arrow] -   Move cursor down one line.
  461.               [PgUp] -   Page up one screen.
  462.               [PgDn] -   Page down one screen.
  463.        [Ctrl]-[PgUp] -   Move cursor to beginning of document.
  464.        [Ctrl]-[PgDn] -   Move cursor to end of document.
  465.                [Ins] -   Toggle cursor between insert and overstrike mode.
  466.                [Del] -   Delete character cursor is on or selected text.
  467.   [Ctrl]-[BackSpace] -   Delete text from cursor to start of line.
  468.        [Shift]-[Ins] -   Copy text from clipboard into document.
  469.        [Shift]-[Del] -   Remove text from document into clipboard.
  470.         [Ctrl]-[Ins] -   Copy text from document into clipboard.
  471.         [Ctrl]-[Del] -   Clear out and dispose of clipboard contents.
  472.  
  473. CREDITS
  474. -------
  475.  
  476. This editor is written in Turbo Pascal 6.0, and  is based on the BORLAND IDE
  477. editor.  MOST of the modifications to the editor kernel were done by
  478.  
  479.                                Al Andersen
  480.                                PO BOX 2436
  481.                          Sierra Vista, AZ 85636
  482.  
  483. and he deserves MUCH credit for his work.
  484.  
  485.